home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / WINPROGS / RTFGEN.ZIP / RTFGEN.TPC < prev    next >
Text File  |  1993-08-11  |  33KB  |  1,087 lines
  1. \docstart
  2. \include rtfgen.mac`
  3. \title Contents`
  4. \topic contents`
  5. \keyword contents`
  6. \browse general:004`
  7. \b
  8. ==========
  9. \S1 Contents`
  10.  
  11. [Overview:overview]`
  12.  
  13. Program Operation`
  14.   [Using RTFGEN to Create a Help File:basicsteps]`
  15.   [Menu Selections:Menu]`
  16.  
  17. Topic Files`
  18.   [General Editing Considerations:EditingConsiderations]`
  19.   [RTFGEN Defaults:Defaults]`
  20.   [Topic File Layout:layout]`
  21.   [Commands:Commands]`
  22.   Macros`
  23.      [WinHelp Macros:WinMacros]`
  24.      [RTFGEN Macros:RtfgenMacros]`
  25.  
  26. [Restrictions and Problems:Restrictions]`
  27. [References:References]`
  28. [Copyright:Copyright]`
  29. ----------
  30.  
  31. \topic Commands`
  32. \title Commands`
  33. \keyword commands`
  34. \browse general:030`
  35. \b   (* all bold *)
  36. ========
  37. \S1 Commands`
  38.  
  39. [Command Syntax:CommandSyntax]`
  40. RTFGEN Commands`
  41.    [Topic Header Commands:TopicHeaderCommands]`
  42.    [Cross Reference Commands:CrossReferences]`
  43.    [Definitions:Definitions]`
  44.    [Bitmap Commands:BitmapCommands]`
  45.    [Block Formatting Commands:BlockFormatting]`
  46.    [\\tabstops command:tabstops]`
  47.    [\\include command:include]`
  48. RTF Commands`
  49.    [Font Commands:FontCommands]`
  50.    [Paragraph Commands:ParagraphCommands]`
  51.    [Tabbing Commands:TabbingCommands]`
  52. ------
  53.  
  54. \title Overview`
  55. \topic overview`
  56. \browse general:005`
  57. ===========
  58. \S1 Overview`
  59.  
  60. Normally, to create a help file with the Windows help compiler,
  61. you must first write a help topic file using a Rich Text Format (RTF)
  62. word processor.  For many, there are two problems here:`
  63.  
  64. \S5`
  65.   1.\tab RTF word processors are expensive.`
  66.   2.\tab The time spent learning to use a new word processor may not be a
  67.      very productive use of one's time.`
  68. \blockend
  69.  
  70. RTFGEN solves both these problems by allowing you to use your favorite
  71. ASCII text editor to produce the RTF formatted files required by the
  72. help compiler.  RTFGEN also automates much of the process of creating help
  73. files:`
  74.  
  75. \S3`
  76. Creates the Help Project File (.HPJ) for the help compiler`
  77. Calls the help compiler from Windows`
  78. Collects any error or warning messages`
  79. Displays the resulting help file`
  80. Optionally creates help context files to be included in your C or Pascal program`
  81. \blockend
  82.  
  83. --------------
  84.  
  85. \title General Editing Considerations`
  86. \topic EditingConsiderations`
  87. \keyword special characters;tabs`
  88. \keyword comments`
  89. \browse general:010`
  90. ========
  91. \S1 General Editing Considerations`
  92.  
  93. Almost any ASCII editor may be used.  I use Borland's BPW IDE.  It's
  94. probably best to turn off options like 'optimal fill'
  95. which can leave invisible and possibly unknown tab characters in the
  96. document.`
  97.  
  98. The use of tabs is required to obtain column allignment with 
  99. proportional fonts.  Either the tab character or the RTF command, 
  100. [\\tab:TabbingCommands], may be used with the same effect.
  101. The \\tab has the advantage
  102. that it's visible in your ASCII file.`
  103.  
  104. RTFGEN and/or the RTF language have special use for the following 
  105. characters:`
  106.  
  107. \blockstart \li1200\tx1200\fi-840`
  108.   {\b\`}    (grave accent)  Used to mark the end of paragraphs.`
  109.   {\b\[}, {\b\]}    Used to mark jumps and definitions.`
  110.   {\b\{}, {\b\}}    Used to mark areas where font characteristics will change.`
  111.   {\b\\}    Used as a command start character.`
  112. \blockend
  113.  
  114. When these characters are to be used in the text, they should be 
  115. preceded by a {\b \\}.  Thus, {\b \\\[} will cause the left bracket to be
  116. inserted in text and {\b \\\\} will result in a single backslash being
  117. inserted in text.`
  118.  
  119. ( * . . . * ) may be used to insert comments within the text.`
  120. --------
  121.  
  122. \title RTFGEN Defaults`
  123. \topic Defaults`
  124. \keyword defaults`
  125. \browse general:015`
  126. =======
  127. \S2 RTFGEN Defaults`
  128.  
  129.    Helv, 10 point font.`
  130.  
  131.    Paragraphs are left justified.  The first line is not
  132.    indented.`
  133.  
  134.    Paragraph indentation is set by indentation of the first
  135.    line of the paragraph.`
  136.  
  137.    Tabs are spaced every 720 [[twips:twipdef]] (about 6 default
  138.    characters).`
  139.  
  140. Any of these defaults may be changed globally for the whole
  141. document, or locally at the topic, paragraph, or even character level.`
  142. ---------
  143.  
  144. \title Using RTFGEN to Create a Help File`
  145. \topic basicsteps`
  146. \keyword using RTFGEN to Cceate a help file;building a help file;help file`
  147. \browse general:008`
  148. =========
  149. \S1 Using RTFGEN to Create a Help File`
  150.  
  151. It's probably a good idea to create a separate directory for your help project.  The
  152. RTFGEN.EXE file can either be in this directory or elsewhere.  The file,
  153. [[HEADING:headingDef]], should be avaiable either in the help project directory or on the
  154. same directory with RTFGEN.EXE.  The Help Compiler should be somewhere on the Path.  You will
  155. need to know the name of the Help Compiler executable -- look for HC30.EXE, HC31.EXE, HC.EXE, or
  156. HCP.EXE.`
  157.  
  158. Once the files are set up, the steps required to create a Windows help file using RTFGEN
  159. are:`
  160.  
  161. \S5`
  162.   1.    Using an ASCII editor, create one or more topic files.  These would
  163.         normally be saved with the .TPC extension.  [See topic file layout:layout]`
  164.   2.    Launch RTFGEN and select {\b Project | Topic Files}.  Enter the name(s) of the topic
  165.         files.`
  166.   3.    From the menu select {\b Project | Options}.  Select the appropriate options.  The
  167.         {\b Help} button provides further information on the selections.`
  168.   4.    Use {\b File | Save As} to save your selections to a Help Project Source file (.HPS)
  169.         while naming your project at the same time.  When you restart your project at a later
  170.         time, it's only necessary to load this .HPS file.`
  171.   5.    {\b Compile | RTF Only} will compile your topic files to form the RTF files (.RTF) and
  172.         the Help ProJect file (.HPJ) required by the Help Compiler.`
  173.   6.    {\b Compile | Help Compiler} invokes the Help Compiler to create the help file itself.`
  174.   7.    {\b Compile | Display Help File} may then be used to call WinHelp to display the help file.`
  175.   8.    The {\b Compile | Full Compile, Display} (or {\b F9} key) combines steps 5, 6, and 7
  176.         in one step and ends by displaying the help file (assuming there were no intervening
  177.         errors).`
  178.   9.    Once you've seen the help file displayed, you'll probably want to return to your
  179.         editor for changes or additions.  You can leave RTFGEN active in Windows and, when it
  180.         comes time to see the help file again, just save it from the editor, enter RTFGEN, and
  181.         hit the F9 key.`
  182. \blockend
  183.  
  184. You can practice using RTFGEN with the demo files included with this package.`
  185.  
  186.    SIMPLE.TPC`
  187.  
  188. can be used to create a very simple help file.`
  189.  
  190.    RTFGEN.TPC`
  191.    MISC.TPC`
  192.    RTFGEN.MAC`
  193.  
  194. are the files necessary to generate this help file.`
  195. ---------
  196.  
  197. \title Menu Selections`
  198. \topic Menu`
  199. \keyword menu`
  200. \browse general:009`
  201. =========
  202. \S1 Menu Selections`
  203.  
  204. \b\fs24 File`
  205.    \b New`
  206.       Start a new help file project.`
  207.    \b Open`
  208.       Open an existing help file project.`
  209.    \b Save`
  210.       Save the help file project.`
  211.    \b Save As`
  212.       Save the help file project with a new name.`
  213.    \b Exit`
  214.       Exit RTFGEN`
  215.  
  216. \b\fs24 Project`
  217.    \b Topic Files...`
  218.       Opens up a [dialog box:Topic_Dialog] to add, change, or delete the project's topic filenames.`
  219.    \b Options...`
  220.       Opens up a [dialog box:OptionDialog] to add, change, or delete the project's options.`
  221.  
  222. \b\fs24 Compile`
  223.    \b RTF Only`
  224.       Compiles the Topic files to yield the RTF files for the help compiler.`
  225.    \b Help Compiler`
  226.       Calls the help compiler to compile the help file from the RTF files.`
  227.    \b Display Help File`
  228.       Displays the help file produced by the help compiler.`
  229.    \b Full Compile, Display`
  230.       Does all three of the above steps at once, assuming no errors.`
  231.  
  232. \b\fs24 Help`
  233.    \b Contents`
  234.       Displays this help file.`
  235.    \b Other Help Files`
  236.       Opens up other help files by selection.`
  237.    \b About`
  238.       The about box.`
  239. -----------
  240.  
  241.  
  242. \topic OptionDialog`
  243. \title Option Dialog`
  244. \keyword option dialog`
  245. ========
  246.  
  247. Click any area to get more information.`
  248.  
  249. \qc \bmc Options.shg`
  250. -----------
  251.  
  252. \topic Op_HelpCompiler`
  253. ========
  254.  
  255. Select whether you want to use version 3